✨ 경기사이버도서관 배너조회 API

• URI : /api/banners
• Method : GET
• Parameter Type : Query Param
• Product Env Request URL : https://www.library.kr/cyber/api/banners

🎮 Request

• type : 서비스 플랫폼 코드

    BPEB : 전자책 서비스
    BPUR : 유저 홈페이지
    BPPT : 택배 서비스
    BPBK : 북매직

• example code

const url = 'https://www.library.kr/cyber/api/banners?type=BPUR';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

📜 Response

• response model

banSeq              : 배너 고유번호 (확인용)
fixYn               : 고정 여부 (확인용) (Y or N 반환)
banImage            : 저장된 이미지 이름 (e.g. 'dasd3434aasdhkji4f.png' )
banImageOriginal    : 이미지 원본명 (e.g. '2024년_공모전.png')
banLink             : 배너링크 (e.g. 'http://www.naver.com')
banActStart         : 게시활성화 시작일 (확인용)
banActEnd           : 게시활성화 종료일 (확인용)

💡 이미지 호출은 아래와 같이 해주세요. (반환된 banImage 파라미터 사용)

• https://www.library.kr/cyber/upload/image/ecs/{banImage}

성공시

• 200 OK

{
  "httpStatus": "OK",
  "message": "OK",
  "data": [
    {
      "banSeq": 1,
      "fixYn": "Y",
      "banImage": "",
      "banImageOriginal": "",
      "banLink": "https://www.naver.com",
      "banActStart": "2024-07-31T15:00:00.000+00:00",
      "banActEnd": "2024-08-27T15:00:00.000+00:00"
    },
    {
      "banSeq": 2,
      "fixYn": "Y",
      "banImage": "",
      "banImageOriginal": "",
      "banLink": "https://www.naver.com",
      "banActStart": "2024-08-01T15:00:00.000+00:00",
      "banActEnd": "2024-08-11T15:00:00.000+00:00"
    },
    {
      "banSeq": 3,
      "fixYn": "N",
      "banImage": "",
      "banImageOriginal": "",
      "banLink": "https://www.naver.com",
      "banActStart": "2024-08-02T15:00:00.000+00:00",
      "banActEnd": "2024-08-28T15:00:00.000+00:00"
    },
    {
      "banSeq": 4,
      "fixYn": "Y",
      "banImage": "",
      "banImageOriginal": "",
      "banLink": "https://www.naver.com",
      "banActStart": "2024-08-03T15:00:00.000+00:00",
      "banActEnd": "2024-08-29T16:00:00.000+00:00"
    }
  ]
}

실패시 - type null or undefined

• 400 BAD REQUEST

{
  "httpStatus": "BAD_REQUEST",
  "errorCode": null,
  "errorResult": null,
  "message": "type is required",
  "errors": null
}

실패시 - 정의되지 않은 type 값 (request 단 문서를 확인해 주세요)

• 400 BAD REQUEST

{
  "httpStatus": "BAD_REQUEST",
  "errorCode": null,
  "errorResult": null,
  "message": "Invalid type. type must be one of 전자책서비스 : BPEB , 유저홈페이지 : BPUR , 택배서비스 : BPPT , 북매직 : BPBK",
  "errors": null
}